- 首页
-
RESTful API
- 账户-用户(User)
-
账户-用户上下文(ClaimMapping)
- 账户-用户扩展属性(CustomProperty)
- 账户-角色(Role)
- 账户-组织(Organization)
- 账户-权限(Permission)
- 账户-授权令牌(AuthToken)
- 账户-安全提供程序(SecurityProviderV)
- 仪表板(Dashboard)
- 数据-数据源(Datasource)
- 数据-数据集(Dataset)
- 数据-数据模型(DataModel)
- 文档-文档(Documents)
- 文档-文档国际化(DocumentTranslateTitle)
- 系统-系统配置(SystemConfig)
- 系统-任务队列(QueueMonitor)
- 系统-插件资源(PluginAssets)
- JavaScript API
ClaimMapping
用户上下文映射(ClaimMapping)
[GET] /api/v2/identity/claim-mappings
获取所有用户上下文。
参数
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| onlyNames | Boolean | query | 是否只检索声明名称。 例如：true |
响应
状态代码: 200
成功
[POST] /api/v2/identity/claim-mappings
添加新的用户上下文。
请求模式
响应
状态代码: 201
成功
状态代码: 400
错误请求
[GET] /api/v2/identity/claim-mappings/{id}
获取指定的用户上下文。
参数
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 用户上下文 ID。 |
响应
状态代码: 200
成功
状态代码: 404
未发现
[PUT] /api/v2/identity/claim-mappings/{id}
修改指定的用户上下文。
参数
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 用户上下文 ID。 |
请求模式
响应
状态代码: 200
成功
状态代码: 400
错误请求
状态代码: 404
未发现
[DELETE] /api/v2/identity/claim-mappings/{id}
删除指定的用户上下文。
参数
| 名称 | 类型 | 位置 | 描述 |
|---|---|---|---|
| id必填项 | string | path | 用户上下文 ID。 |
响应
状态代码: 204
成功
状态代码: 400
错误请求
状态代码: 404
未发现
模型定义
Ƭ ClaimMappingModel
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| id可为空 | string | ||
| name | string | ||
| propName | string | ||
| isBuiltIn | Boolean |
Ƭ ApiErrorResult
用来描述处理网络请求时发生的所有错误的模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| errors可为空 | ApiError | 错误列表。 |
Ƭ ApiError
用来描述处理网络请求时发生的错误的模型。
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code可为空 | string | 错误的唯一标识。 | |
| message可为空 | string | 错误的描述文本。 | |
| context可为空 | string | 错误的一些相关上下文信息。 |
Ƭ ClaimMappingCreationModel
| 名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
| name | string | 声明名称。 | "gender" |
| propName | string | 自定义属性名称。 | "Gender" |